home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / rpcstat / RCS / rpcstat.man,v < prev   
Text File  |  1992-07-10  |  8KB  |  368 lines
  1. head     1.8;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.8
  10. date     92.07.10.15.26.27;  author kupfer;  state Exp;
  11. branches ;
  12. next     1.7;
  13.  
  14. 1.7
  15. date     92.07.10.15.17.39;  author kupfer;  state Exp;
  16. branches ;
  17. next     1.6;
  18.  
  19. 1.6
  20. date     90.12.06.10.40.30;  author mendel;  state Exp;
  21. branches ;
  22. next     1.5;
  23.  
  24. 1.5
  25. date     89.06.23.15.49.59;  author brent;  state Exp;
  26. branches ;
  27. next     1.4;
  28.  
  29. 1.4
  30. date     89.06.23.13.37.40;  author brent;  state Exp;
  31. branches ;
  32. next     1.3;
  33.  
  34. 1.3
  35. date     88.12.30.10.13.02;  author ouster;  state Exp;
  36. branches ;
  37. next     1.2;
  38.  
  39. 1.2
  40. date     88.12.22.11.38.21;  author ouster;  state Exp;
  41. branches ;
  42. next     1.1;
  43.  
  44. 1.1
  45. date     88.11.08.15.37.07;  author brent;  state Exp;
  46. branches ;
  47. next     ;
  48.  
  49.  
  50. desc
  51. @Man page for the rpcstat command
  52. @
  53.  
  54.  
  55. 1.8
  56. log
  57. @Start a BUGS section: note that many buckets will always have a count
  58. of 0 because of the coarse system clock resolution.
  59. @
  60. text
  61. @' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.7 92/07/10 15:17:39 kupfer Exp Locker: kupfer $ SPRITE (Berkeley)
  62. .so \*(]ltmac.sprite
  63. .HS RPCSTAT cmds
  64. .BS
  65. .SH NAME
  66. rpcstat \- Print out statistics about the RPC system
  67. .SH SYNOPSIS
  68. \fBrpcstat\fR  [\fIoptions\fR]
  69. .SH OPTIONS
  70. .IP "\fB\-trace\fR" 14
  71. Print out the RPC trace.
  72. .IP "\fB\-cinfo\fR"
  73. Print client-side RPC system statistics.
  74. .IP "\fB\-sinfo\fP"
  75. Print server-side RPC system statistics.
  76. .IP "\fB\-chan\fP"
  77. Print the state of the client RPC channels.
  78. .IP "\fB\-srvr\fP"
  79. Print the state of the RPC server processees.
  80. .IP "\fB\-calls\fP"
  81. Print the number of RPC calls made.
  82. .IP "\fB\-rpcs\fP"
  83. Print the number of RPC calls serviced.
  84. .IP "\fB\-chist\fP"
  85. Display the client-side RPC histograms.
  86. .IP "\fB\-shist\fP"
  87. Display the server-side RPC histograms.
  88. .IP "\fB\-zero\fP"
  89. Print the zero valued counts.
  90. .IP "\fB\-nohostdb\fP"
  91. Do not search the host database file.
  92. .BE
  93. .SH INTRODUCTION
  94. This command is used to get statistics and trace information about the
  95. Sprite kernel-to-kernel RPC system.
  96. .SH "RPC TRACE"
  97. .PP
  98. The RPC trace has a record for the
  99. last 100 packets sent or received in the RPC network protocol.  The trace
  100. has the following fields:
  101. .DS
  102. \fBID code time flag commnd client server psize dsize doff fragment\fR
  103. .DE
  104. .IP \fBID\fR 10
  105. The RPC sequence number.  A new ID is generated for each RPC, and
  106. all packets involved with an RPC contain this ID.
  107. .IP \fBcode\fR 10
  108. Either "in" or "out" to mean the packet was transmitted or received.
  109. .IP \fBtime\fR 10
  110. Seconds since last packet.  Sun3 clock granularity is too low (10 msec) for this
  111. to be meaningful.
  112. .IP \fBflag\fR 10
  113. .DS
  114. \fBQ\fP reQuest packet.
  115. \fBQp\fP reQuest with please acknowledge bit set.
  116. \fBA\fP Acknowledgment packet.
  117. \fBR\fP Reply packet.
  118. \fBRe\fP Error reply; command field contains error code.
  119. \fBAc\fP Close acknowledgment sent to close client/server binding.
  120. .DE
  121. .IP \fBcommand\fR 10
  122. The RPC name.  If this is a number and the flag field is "Re",
  123. then this is the returned error code.
  124. .IP \fBclient\fR 10
  125. Two numbers identify the client host and the client channel number.
  126. .IP \fBserver\fR 10
  127. Two numbers identify the server host and the server process number.
  128. .IP \fBpsize\fR 10
  129. The size of the parameter area of the packet.
  130. .IP \fBdsize\fR 10
  131. The size of the data area of the packet
  132. .IP \fBdoff\fR 10
  133. The offset of the data area.  Used when fragmenting large data blocks.
  134. .IP \fBfragment\fR 10
  135. Two numbers are the number of fragments and the fragment bitmask.
  136. .SH "CLIENT RPC"
  137. .PP
  138. The client half of the RPC system maintains statistics about the
  139. number of timeouts, retransmissions, etc.  The output of the \fB\-cinfo\fP
  140. option is (nearly) self-explanatory.  There are also a set of
  141. \fIchannels\fP used by the client side of RPC.  Each channel is
  142. dynamically bound to a particular server host/process pair, and
  143. the kernel attempts to reuse the channel for successive RPCs to that server.
  144. The \fB\-chan\fP option prints out the state of the client channels,
  145. what they are bound to, what RPC is in progress, etc.
  146. The binding is not hard, but is used to optimize away explicit
  147. acknowledgment packets.
  148. .SH "SERVER RPC"
  149. .PP
  150. The server half of the RPC system maintains statistics about the
  151. number of requests it has received, the number of requests that
  152. implicitly acknowledged a previous reply, etc.  The output of
  153. the \fB\-sinfo\fP option is (nearly) self-explanatory.  There are also
  154. a pool of kernel RPC server processes.  The \fB\-srvr\fP option
  155. prints out the state of each, their current client, the current RPC, etc.
  156. .SH HISTOGRAMS
  157. .PP
  158. The kernel can keep track of how long RPCs take.  For each RPC number
  159. the kernel keeps the total time spent processing that RPC command, as
  160. well as a histogram showing the distribution of times.  The
  161. .B \-chist
  162. option displays the client-side timings, whereas
  163. .B \-shist
  164. displays the server-side timings.  These options display the following
  165. information for each RPC command: the command name, the number of
  166. calls, the average time per call, the overhead for collecting the
  167. timing information, and the timing distribution for the command.  The
  168. timing distribution is a series of double lines.  The top line gives
  169. the minimum times for a series of buckets, in microseconds, and the
  170. bottom line gives the number of RPCs that fell into that bucket.
  171. .PP
  172. Use
  173. .B rpccmd
  174. to enable, disable, or reset these timings.
  175. .SH BUGS
  176. On current Sprite systems, the histogram resolution is finer than the
  177. clock resolution, so many buckets will always have a count of 0.
  178. .SH "SEE ALSO"
  179. rpccmd
  180. .SH KEYWORDS
  181. rpc, server, client, channel
  182. @
  183.  
  184.  
  185. 1.7
  186. log
  187. @Document histogram support.  Fix synposis line.  Fix documentation for
  188. some options that were apparently renamed some time ago.
  189. @
  190. text
  191. @d1 1
  192. a1 1
  193. ' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.6 90/12/06 10:40:30 mendel Exp Locker: kupfer $ SPRITE (Berkeley)
  194. d115 3
  195. @
  196.  
  197.  
  198. 1.6
  199. log
  200. @Added the nohostdb option.
  201. @
  202. text
  203. @d1 1
  204. a1 1
  205. ' $Header: /sprite/src/cmds/rpcstat/RCS/rpcstat.man,v 1.5 89/06/23 15:49:59 brent Exp Locker: mendel $ SPRITE (Berkeley)
  206. d8 1
  207. a8 1
  208. \fBrpcstat\fR  -[\foptions\fR]
  209. d24 4
  210. d79 2
  211. a80 2
  212. number of timeouts, retransmissions, etc.  The output of the \fB\-C\fP
  213. option is (nearly) self-explanitory.  There are also a set of
  214. d84 1
  215. a84 1
  216. The \fB\-c\fP option prints out the state of the client channels,
  217. d93 2
  218. a94 2
  219. the \fB\-S\fP option is (nearly) self-explanitory.  There are also
  220. a pool of kernel RPC server processes.  The \fB\-s\fP option
  221. d96 21
  222. @
  223.  
  224.  
  225. 1.5
  226. log
  227. @fixed typo
  228. @
  229. text
  230. @d1 1
  231. a1 1
  232. ' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.4 89/06/23 13:37:40 brent Exp Locker: brent $ SPRITE (Berkeley)
  233. d26 2
  234. @
  235.  
  236.  
  237. 1.4
  238. log
  239. @Updated to handle new option formats
  240. @
  241. text
  242. @d1 1
  243. a1 1
  244. ' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.3 88/12/30 10:13:02 ouster Exp Locker: brent $ SPRITE (Berkeley)
  245. d8 1
  246. a8 1
  247. \fBrpcstat\fR  -[\fBtCScs\fR]
  248. @
  249.  
  250.  
  251. 1.3
  252. log
  253. @More format upgrades.
  254. @
  255. text
  256. @d1 1
  257. a1 1
  258. ' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.2 88/12/22 11:38:21 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  259. d10 1
  260. a10 1
  261. .IP "\fB\-t\fR" 14
  262. d12 1
  263. a12 1
  264. .IP "\fB\-C\fR"
  265. d14 1
  266. a14 1
  267. .IP "\fB\-S\fP"
  268. d16 1
  269. a16 1
  270. .IP "\fB\-c\fP"
  271. d18 1
  272. a18 1
  273. .IP "\fB\-s\fP"
  274. d20 6
  275. @
  276.  
  277.  
  278. 1.2
  279. log
  280. @Format upgrade.
  281. @
  282. text
  283. @d1 1
  284. a1 1
  285. ' $Header: /a/newcmds/rpcstat/RCS/rpcstat.man,v 1.1 88/11/08 15:37:07 brent Exp $ SPRITE (Berkeley)
  286. d10 1
  287. a10 1
  288. .IP "\fB-t\fR" 14
  289. d12 1
  290. a12 1
  291. .IP "\fB-C\fR"
  292. d14 1
  293. a14 1
  294. .IP "\fB-S\fP"
  295. d16 1
  296. a16 1
  297. .IP "\fB-c\fP"
  298. d18 1
  299. a18 1
  300. .IP "\fB-s\fP"
  301. d30 1
  302. a30 2
  303.  
  304. ID code time flag commnd client server psize dsize doff fragment
  305. d32 1
  306. a32 1
  307. .IP ID 10
  308. d35 1
  309. a35 1
  310. .IP code 10
  311. d37 1
  312. a37 1
  313. .IP time 10
  314. d40 1
  315. a40 1
  316. .IP flag 10
  317. d49 1
  318. a49 1
  319. .IP command 10
  320. d52 1
  321. a52 1
  322. .IP client 10
  323. d54 1
  324. a54 1
  325. .IP server 10
  326. d56 1
  327. a56 1
  328. .IP psize 10
  329. d58 1
  330. a58 1
  331. .IP dsize 10
  332. d60 1
  333. a60 1
  334. .IP doff 10
  335. d62 1
  336. a62 1
  337. .IP fragment 10
  338. d67 1
  339. a67 1
  340. number of timeouts, retransmissions, etc.  The output of the \fB-C\fP
  341. d72 1
  342. a72 1
  343. The \fB-c\fP option prints out the state of the client channels,
  344. d81 2
  345. a82 2
  346. the \fB-S\fP option is (nearly) self-explanitory.  There are also
  347. a pool of kernel RPC server processes.  The \fB-s\fP option
  348. @
  349.  
  350.  
  351. 1.1
  352. log
  353. @Initial revision
  354. @
  355. text
  356. @d1 3
  357. a3 2
  358. ' $Header: /sprite/doc/ref/cmds/RCS/rpcecho,v 1.1 88/10/31 14:10:06 brent Exp $ SPRITE (Berkeley)
  359. .TH rpcstat prog
  360. d5 1
  361. a5 1
  362. .NA
  363. d7 2
  364. a8 2
  365. .SY
  366. \fBrpcstat\fR  -[tCScs]
  367. @
  368.